Skip to main content

Rest Service

This activity sends an HTTP request to a specified REST API endpoint and returns the response. It is used for integrating external services within automation workflows.

Core Functions​

  • Sends HTTP requests to REST API endpoints
  • Supports different HTTP methods (GET, POST, PUT, DELETE, etc.)
  • Receives and processes API responses
  • Enables integration with external web services
  • Supports optional delay and error-handling configuration

Inputs​

  • Endpoint: Specifies the REST API URL to send the request to
    Type: String

  • Method: Defines the HTTP method used for the request (e.g., GET, POST, PUT, DELETE)
    Type: String

  • Delay Before: Defines the wait time before the activity starts execution
    Type: Int32 / TimeSpan

  • Delay After: Defines the wait time after the activity completes
    Type: Int32 / TimeSpan

  • Description: Provides a short description of the activity for documentation purposes
    Type: String

  • Display Name: Defines the name shown for the activity in the workflow
    Type: String

  • Ignore Error: Determines whether errors should be ignored during execution
    Type: Boolean

Outputs​

  • Output: Returns the response received from the REST API call
    Type: String / JSON / Object

Short Technical Summary​

Sends an HTTP request to a specified REST endpoint using the defined method and returns the response for further processing in automation workflows.